home *** CD-ROM | disk | FTP | other *** search
/ Creative Computers / Creative Computers CD-ROM, Volume 1 (Legendary Design Technologies, Inc.)(1994).iso / shareware / music / edplayer_2.1 / edplayer.docs / edp2.1.commands.doc < prev    next >
Text File  |  1994-11-17  |  39KB  |  780 lines
  1. ============================================================================
  2.  
  3.                     A R E X X / T E L L E D   S E C T I O N
  4.  
  5. ============================================================================
  6.  
  7. This section describes EdPlayer commands which can be issued from ARexx,
  8. or from programs like telled/cteled.  I'll try to explain it so that even
  9. people who are not familiar with ARexx can use the commands.
  10.  
  11. EdPlayer has a special message port.  This port is more than an ARexx port,
  12. because it can accept both ARexx messages and special "EdPlayer" messages
  13. in the same port.  The reason for this is that some unfortunate people
  14. using OS1.3 still don't have ARexx!  What are you guys waiting for??
  15.  
  16. Anyway, included in this archive are two programs and their respective
  17. source codes, called "Telled" (Telled.asm) and "cteled" (cteled.c).  The
  18. two are almost identical:  Telled was written in Assembly, being as SMALL
  19. as possible, for easy use in script files.  Cteled was written in Aztec C,
  20. and is somewhat larger because it actually returns error messages on the
  21. screen.  Both of these programs transmit the special "EdPlayer" messages so
  22. that ARexx is not required.  Their source codes are provided in case you
  23. want to write your own programs that transmit these messages.  However, it
  24. is strongly recommended that you look up in your ARexx manual the proper
  25. way of sending true ARexx messages, so that you know how to send messages to
  26. other ARexx applications, not just EdPlayer.
  27.  
  28. In EdPlayer 2.0, two new programs appear in the archive:  "AskEd.rexx" and
  29. "wport" (wport.c).  AskEd.rexx is an ARexx script that should be used to
  30. send the ARexx queries.  EdPlayer cannot return a result (other than an
  31. error) to telled and cteled, so you must use "rx AskEd <query>" to get
  32. responses from EdPlayer.  Wport is a little program I wrote that waits
  33. for the EDPLAYER message port to appear.  This is very useful for scripts
  34. that launch EdPlayer and immediately try to send it commands; these scripts
  35. should wait (with wport) for EdPlayer to set up its message port first. 
  36. See wport.c (it's commented) for info on how to use wport.
  37.  
  38. For those of you making script files:  If you have ARexx, you'll almost
  39. certainly want to make ARexx scripts instead of CLI scripts.  For that, use
  40. an "address 'EDPLAYER'" type command.  Again, see your ARexx manual for
  41. more details.  NOTE:  rexx:Startup.EdP (the startup script)
  42. should ** NOT ** contain an "address 'EDPLAYER'" command!  It automatically
  43. addresses a special startup message port, so that programs waiting with
  44. wport or whatever don't mix their messages in before the startup script
  45. completes.  ANYWAY, for you people without ARexx, you're stuck making CLI
  46. scripts!  For this, use "telled" or "cteled" as described here:  NOTE!: the
  47. parameters are different.  Telled does NOT use quotes, while cteled DOES:
  48.  
  49. CORRECT:
  50.      >>>>   telled PLAY mod.cream of the earth
  51. ;Note that telled NEVER needs any quotes no matter how many spaces are
  52. ;in the line.
  53.  
  54.      >>>>   cteled "PLAY mod.cream of the earth"
  55. ;Note that cteled NEEDS quotes, and all parameters go in the SAME
  56. ;set of quotes, because EdPlayer will parse it, NOT cteled.
  57.  
  58.      >>>>   telled play mod.cream of the earth
  59. ;NEW for EdP v1.1: Commands are no longer case-sensitive,
  60. ;EXCEPT the "MIDL" command's parameter which needs to be
  61. ;case-sensitive for looking up a midi_destination.
  62.  
  63. INCORRECT:
  64.             telled "PLAY mod.test module"   ;telled NEVER needs quotes
  65.                    X                    X
  66.  
  67.             cteled "PLAY" "mod.test module" ;put ALL in one set of quotes
  68.                         X X
  69.  
  70. Well, I hope you can get the hang of that.  There should be some example
  71. scripts in the archive, for more examples of sending commands.
  72.  
  73. ----------------------------------------------------------------------------
  74.  
  75. Now it's time for a complete list of commands.  Note that you may give ANY
  76. of these commands to EdPlayer by (1) using the CLI/Shell to issue "telled"
  77. or "cteled" as shown above, or (2) send the commands via ARexx to the ARexx
  78. port "EDPLAYER" (port name is all caps).
  79.  
  80. I'll list the commands in the order they were created.
  81.  
  82. *** New for 2.0: Some commands are no longer 4 letters.  However, only the
  83.     first 4 letters of ANY command are needed.  Users complained that they
  84.     wanted to type "pause" instead of "paus", "eject" instead of "ejec",
  85.     etc.  You can now do this (a) for commands that need no parameters
  86.     (this was actulally an undocumented feature in previous versions),
  87.     and (b) for commands that accept numbers as parameters.  You may
  88.     NOT do it for commands that accept text as a parameter, such
  89.     as LOAD, PLAY, JUKE, and MIDL.  These commands still need to be
  90.     only 4 letters long, with ONE SPACE between them and their parameter.
  91.     (The exception is the MESS command, which can be extended to MESSAGE).
  92.  
  93. Commands are presented with the first four letters capitalized.  These
  94. letters are the only ones used by EdPlayer to identify the command.
  95. Any letters after them are optional, they are there just to make
  96. script files more readable.  For example, the command presented as "MESSage"
  97. may be sent to EdPlayer as "mess", as "message", or even as
  98. "messInTheHall".  EdPlayer only looks at the first 4 letters.
  99.  
  100. Parameters in [<brackets>] are optional.
  101.  
  102. Parameters in <these things> are required!
  103.  
  104. LOAD <filename>
  105.        This command is used to load a module into EdPlayer.  EdPlayer
  106.        automatically figures out what module type it is, but does not yet
  107.        start to play it.  This command can NOT be used with programs!  It
  108.        erases the current program.  If you want to use programs, see JUKE
  109.        below.  Anyway, LOAD will wait until the module finishes loading
  110.        before it returns, so it can report if there was an error or not.
  111.        Note:  ALWAYS use a FULL PATH with LOAD, because the current
  112.        directory of EdPlayer may not match the current directory of the
  113.        program sending the command.
  114.        NEW for EdP v1.1:  If you want to load a PP encrypted module, you
  115.        can do this:   LOAD volume:path/modulename|password
  116.        (Please note the LACK of spaces around the "|").
  117.        If you don't give a password when needed, a password requester opens.
  118.        query: see ANAM.
  119.  
  120. PLAY [<filename>]
  121.        This command can be used with or without the parameter.  If it is
  122.        given with no parameter, it will attempt to play the current song. 
  123.        If there is a parameter, it will call LOAD first, and then PLAY.  
  124.        This command will wait for the module to load, so it can report
  125.        errors like LOAD does, but it will return once the song begins to
  126.        play.  Note:  This is NOT the same as the PLAY button on the CD,
  127.        because there is no PAUSE feature here.
  128. ***    NEW for EdP v2.0:  If there is no current song, and no parameter,
  129.        but there IS a current program, PLAY will grab a name from the
  130.        program and use it.  To launch a program, I recommend PJUM, not PLAY.
  131.        see PAUS, CONT, PJUM, and NEXT.  query: see ANAM.
  132.  
  133. STOP
  134.        Stops the music immediately, just like the STOP button.
  135.  
  136. EJECt
  137.        Ejects the current song, un-loading it from your CHIP mem.
  138.        (Just like the EJECT button!)  Does nothing to your program.
  139.        see ERAS
  140.  
  141. VOLUme <volume>
  142.        Sets the music's volume, and affects the volume slide on the CD
  143.        player panel.  <volume> can be an integer from 0 to 64.
  144.        The default is 64, the loudest.
  145.        see FADE.  query: see AVOL.
  146.  
  147. PAUSe [<rate>]
  148.        This will pause the music.  If there is no parameter, the music will
  149.        pause immediately.  If there is a <rate>, then the music will fade
  150.        to a pause.  Common <rate>s are:  1 = Very slow, 2 = slow,
  151.        4 = initial default fade rate from CD panel, 8 = medium fast, 16 =
  152.        fast. Integers from 1 to 32 usually work OK.  NOTE: Entering a new
  153.        PAUSE rate may not affect the end-of-song fade-out rate, BUT, it
  154.        WILL set a new default for the panel's rate for everything.  So next
  155.        time someone uses the panel to fade something, it will happen in the
  156.        last-used <rate>.  This side-effect on the panel goe